Update Destination

Route

/v2/streaming/destinations/{destination.id}

Description

Update an existing streaming destination with the provided configuration.

Method

PATCH

Inputs

Parameter	Type	Required	Description
destination.id	string	Yes	The unique identifier of the destination
name	string	Yes	Human-readable name for the destination
description	string	No	Detailed description of the destination
format	string	Yes	Data format (json_lines, json)
type	string	Yes	Destination type (https)
encoding	string	No	Data encoding (gzip, encoding_unspecified)
https_config	object	No	HTTPS destination configuration

Query Parameters

Parameter	Type	Required	Description
fields	string	No	Specifies which fields to update

Request Body

{
  "name": "Updated SIEM",
  "description": "Updated security information and event management system",
  "format": "json_lines",
  "type": "https",
  "encoding": "gzip",
  "https_config": {
    "uri": "https://new-siem.company.com/api/events",
    "ignore_ssl_errors": false
  }
}

Output

Field	Type	Description
resources	array[Destination]	Array containing the updated destination
errors	array[Error]	Any errors encountered

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "id": "dest-123",
      "name": "Updated SIEM",
      "description": "Updated security information and event management system",
      "format": "json_lines",
      "type": "https",
      "encoding": "gzip",
      "https_config": {
        "uri": "https://new-siem.company.com/api/events",
        "ignore_ssl_errors": false
      }
    }
  ],
  "errors": []
}